[skip changelog] Add documentation for compile components of the gRPC interface #695
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
topic: documentation
…gRPC interface Comments added to the .proto files are included in the generated gRPC interface documentation.
|
I have now rebased on |
rsora
approved these changes
May 19, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
Add explanatory comments for the compile components of the gRPC interface to the source code. These comments will be included in the generated gRPC interface documentation.
There is insufficient explanation of the gRPC interface in the documentation.
Improved documentation of the gRPC interface.
No
I followed the style convention of using comments at the end of the code line that had been previously established in compile.proto. This resulted in compile.pb.go not being changed, since protoc does not transfer this type of comments.